Frameworks/Adium Framework/SUSpeaker.h

   1 //
   2 //  SUSpeaker.h
   3 //
   4 //  Created by raf on Sun Jan 28 2001.
   5 //  Based on SpeechUtilities framework by Raphael Sebbe.
   6 //  Revised by Evan Schoenberg on Tue Sep 30 2003.
   7 //  Optimized and expanded by Evan Schoenberg.
   8
   9 #import <Foundation/Foundation.h>
  10 #import <Carbon/Carbon.h>
  11
  12 /*!
  13  * @class SUSpeaker
  14  * @brief Cocoa wrapper for the Carbon Speech Synthesis Manager
  15  */
  16 @interface SUSpeaker : NSObject
  17 {
  18     SpeechChannel _speechChannel;
  19     id _delegate;
  20     NSPort *_port;
  21         NSData *currentSpeechMacRomanData;
  22
  23     BOOL _usePort;
  24     unsigned int _reserved1;
  25     unsigned int _reserved2;
  26 }
  27
  28 + (NSArray *)voiceNames;
  29 //+(NSString*) defaultVoiceName;
  30
  31 //pitch is in Hertz.
  32 - (void) setPitch:(float)pitch;
  33 - (float) pitch;
  34 //rate is in words per minute.
  35 - (void) setRate:(float)rate;
  36 - (float) rate;
  37
  38 -(void)setVolume:(float)vol;
  39
  40 //voice is an index into +voiceNames. pass -1 for the default voice.
  41 - (void) setVoiceUsingIndex:(int)index;
  42
  43 - (void) speakText:(NSString*)text;
  44 - (void) stopSpeaking;
  45
  46 - (void) resetToDefaults;
  47
  48 //e.g., for Bad News: 'The light you see at the end of the tunnel is the headlamp of a fast approaching train.' (remember that Bad News is a singing voice...)
  49 - (NSString *)demoTextForVoiceAtIndex:(int)voiceIndex;
  50
  51 -(void) setDelegate:(id)delegate;
  52 -(id) delegate;
  53
  54 @end
  55
  56 @interface NSObject (SUSpeakerDelegate)
  57 -(void) didFinishSpeaking:(SUSpeaker*)speaker;
  58 -(void) willSpeakWord:(SUSpeaker*)speaker at:(int)where length:(int)length;
  59 @end